-
Notifications
You must be signed in to change notification settings - Fork 745
/
IDataService.cs
79 lines (69 loc) · 4.34 KB
/
IDataService.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information
namespace DotNetNuke.Services.Social.Subscriptions.Data
{
using System.Data;
public interface IDataService
{
/// <summary>Adds a Subscription Type.</summary>
/// <param name="subscriptionName">Subscription Type Name.</param>
/// <param name="friendlyName">Subscription Type FriendlyName.</param>
/// <param name="desktopModuleId">DesktopModule Id.</param>
/// <returns>Subscription Type Id.</returns>
int AddSubscriptionType(string subscriptionName, string friendlyName, int desktopModuleId);
/// <summary>Returns all the Subscription Types.</summary>
/// <returns>Subscription types.</returns>
IDataReader GetSubscriptionTypes();
/// <summary>Deletes a Subscription Type.</summary>
/// <param name="subscriptionTypeId">Subscription Type Id.</param>
/// <returns>True if the subscription type has been deleted, false otherwise.</returns>
bool DeleteSubscriptionType(int subscriptionTypeId);
/// <summary>Adds a Subscription.</summary>
/// <param name="userId">User Id.</param>
/// <param name="portalId">Portal id.</param>
/// <param name="subscriptionTypeId">Subscription Type Id.</param>
/// <param name="objectKey">Object Key.</param>
/// <param name="description">Description.</param>
/// <param name="moduleId">Module Id.</param>
/// <param name="tabId">Tab Id.</param>
/// <param name="objectData">Object Data.</param>
/// <returns>Subscription Id.</returns>
int AddSubscription(int userId, int portalId, int subscriptionTypeId, string objectKey, string description, int moduleId, int tabId, string objectData);
/// <summary>Returns the User Subscriptions.</summary>
/// <param name="portalId">Portal Id.</param>
/// <param name="userId">User Id.</param>
/// <param name="subscriptionTypeId">Subscription Type Id.</param>
/// <returns>Collection of Subscriptions.</returns>
IDataReader GetSubscriptionsByUser(int portalId, int userId, int subscriptionTypeId);
/// <summary>Returns the Content Subscriptions.</summary>
/// <param name="portalId">Portal Id.</param>
/// <param name="subscriptionTypeId">Subscription Type Id.</param>
/// <param name="objectKey">Object Key.</param>
/// <returns>Collection of Subscriptions.</returns>
IDataReader GetSubscriptionsByContent(int portalId, int subscriptionTypeId, string objectKey);
/// <summary>Checks if the user is subscribed to an ObjectKey.</summary>
/// <param name="portalId">Portal Id.</param>
/// <param name="userId">User Id.</param>
/// <param name="subscriptionTypeId">Subscription Type.</param>
/// <param name="objectKey">Object Key.</param>
/// <param name="moduleId">Module Id.</param>
/// <param name="tabId">Tab Id.</param>
/// <returns>Subscription.</returns>
IDataReader IsSubscribed(int portalId, int userId, int subscriptionTypeId, string objectKey, int moduleId, int tabId);
/// <summary>Deletes a Subscription.</summary>
/// <param name="subscriptionId">Subscription Id.</param>
/// <returns>True if the subscription has been deleted, false otherwise.</returns>
bool DeleteSubscription(int subscriptionId);
/// <summary>Updates a Subscription Description.</summary>
/// <param name="objectKey">Subscription Object Key.</param>
/// <param name="portalId">Subscription Portal Id.</param>
/// <param name="newDescription">New Subscription Description.</param>
/// <returns>The number of subscription descriptions that have been updated.</returns>
int UpdateSubscriptionDescription(string objectKey, int portalId, string newDescription);
/// <summary>Deletes all subscriptions matching the specified object key.</summary>
/// <param name="portalId">Portal Id.</param>
/// <param name="objectKey">Object Key.</param>
void DeleteSubscriptionsByObjectKey(int portalId, string objectKey);
}
}